Get Communication Services Data

The Get Communication Services Data request retrieves a snapshot of all Communication Services data currently cached for the customer including voice policies, routing configurations, dial plans, and other Teams telephony settings.

The customer must exist and have a fully provisioned cache service.

URI

Copy

{{baseUrl}}/api/v3/customer/{UmpCustomerGuid}/csdata

HTTP Method

GET

Request Body

Attribute	Type	Description
X-IAM-Account-Id	integer channel identifier	Filter access to customers belonging to the specified channel. See Get List of Channels to retrieve channel Ids.

Example Response

Copy

{
    "policy": {
        "onprem": {},
        "skypeonline": {
            "callinglineidentity": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "externalaccess": [
                {
                    "Id": "FederationAndPICDefault",
                    "Name": "FederationAndPICDefault"
                },
                {
                    "Id": "FederationOnly",
                    "Name": "FederationOnly"
                },
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "NoFederationAndPIC",
                    "Name": "NoFederationAndPIC"
                }
            ],
            "onlinevoicemail": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Default",
                    "Name": "Default"
                },
                {
                    "Id": "TranscriptionDisabled",
                    "Name": "TranscriptionDisabled"
                },
                {
                    "Id": "TranscriptionProfanityMaskingEnabled",
                    "Name": "TranscriptionProfanityMaskingEnabled"
                }
            ],
            "onlinevoiceroutingpolicy": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Unrestricted",
                    "Name": "Unrestricted"
                }
            ],
            "teamsapppermission": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsappsetup": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "FirstLineWorker",
                    "Name": "FirstLineWorker"
                }
            ],
            "teamsaudioconferencing": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamscalling": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "AllowCalling",
                    "Name": "AllowCalling"
                },
                {
                    "Id": "AllowCallingPreventForwardingtoPhone",
                    "Name": "AllowCallingPreventForwardingtoPhone"
                },
                {
                    "Id": "AllowCallingPreventTollBypass",
                    "Name": "AllowCallingPreventTollBypass"
                },
                {
                    "Id": "DisallowCalling",
                    "Name": "DisallowCalling"
                }
            ],
            "teamscallpark": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamschannels": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Default",
                    "Name": "Default"
                }
            ],
            "teamscompliancerecording": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsemergencycalling": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsemergencycallrouting": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsfeedback": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Disabled",
                    "Name": "Disabled"
                },
                {
                    "Id": "Enabled",
                    "Name": "Enabled"
                },
                {
                    "Id": "UserChoice",
                    "Name": "UserChoice"
                }
            ],
            "teamsipphone": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsmeeting": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "AllOff",
                    "Name": "AllOff"
                },
                {
                    "Id": "AllOn",
                    "Name": "AllOn"
                },
                {
                    "Id": "Default",
                    "Name": "Default"
                },
                {
                    "Id": "Kiosk",
                    "Name": "Kiosk"
                },
                {
                    "Id": "RestrictedAnonymousAccess",
                    "Name": "RestrictedAnonymousAccess"
                },
                {
                    "Id": "RestrictedAnonymousNoRecording",
                    "Name": "RestrictedAnonymousNoRecording"
                }
            ],
            "teamsmeetingbroadcast": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Default",
                    "Name": "Default"
                }
            ],
            "teamsmessaging": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Default",
                    "Name": "Default"
                },
                {
                    "Id": "EduFaculty",
                    "Name": "EduFaculty"
                },
                {
                    "Id": "EduStudent",
                    "Name": "EduStudent"
                }
            ],
            "teamssurvivablebranchappliance": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "teamsupgrade": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "Islands",
                    "Name": "Islands"
                },
                {
                    "Id": "IslandsWithNotify",
                    "Name": "IslandsWithNotify"
                },
                {
                    "Id": "SfBOnly",
                    "Name": "SfBOnly"
                },
                {
                    "Id": "SfBOnlyWithNotify",
                    "Name": "SfBOnlyWithNotify"
                },
                {
                    "Id": "SfBOnlyWithOutNotify",
                    "Name": "SfBOnlyWithOutNotify"
                },
                {
                    "Id": "SfBWithTeamsCollab",
                    "Name": "SfBWithTeamsCollab"
                },
                {
                    "Id": "SfBWithTeamsCollabAndMeetings",
                    "Name": "SfBWithTeamsCollabAndMeetings"
                },
                {
                    "Id": "SfBWithTeamsCollabAndMeetingsWithNotify",
                    "Name": "SfBWithTeamsCollabAndMeetingsWithNotify"
                },
                {
                    "Id": "SfBWithTeamsCollabWithNotify",
                    "Name": "SfBWithTeamsCollabWithNotify"
                },
                {
                    "Id": "UpgradeToTeams",
                    "Name": "UpgradeToTeams"
                }
            ],
            "teamsvideointeropservice": [
                {
                    "Id": "Global",
                    "Name": "Global"
                },
                {
                    "Id": "BlueJeansServiceProviderEnabled",
                    "Name": "BlueJeansServiceProviderEnabled"
                },
                {
                    "Id": "CiscoServiceProviderEnabled",
                    "Name": "CiscoServiceProviderEnabled"
                },
                {
                    "Id": "PexipServiceProviderEnabled",
                    "Name": "PexipServiceProviderEnabled"
                },
                {
                    "Id": "PolycomServiceProviderEnabled",
                    "Name": "PolycomServiceProviderEnabled"
                },
                {
                    "Id": "ServiceProviderDisabled",
                    "Name": "ServiceProviderDisabled"
                }
            ],
            "tenantdialplan": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ]
        }
    },
    "configuration": {
        "onprem": {},
        "skypeonline": {
            "azureaddomain": [
                {
                    "Id": "NoIdentity",
                    "Name": "NoIdentity"
                }
            ],
            "networkroamingpolicy": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "onlinepstnusage": [
                {
                    "Id": "Global",
                    "Name": "Global"
                }
            ],
            "onlinevoiceroute": [
                {
                    "Id": "LocalRoute",
                    "Name": "LocalRoute"
                },
                {
                    "Id": "Unrestricted",
                    "Name": "Unrestricted"
                }
            ]
        }
    }
}

HTTP Responses

■

200 OK

All arrays in this schema contain objects with the following structure.

Parameter	Type	Description
Id	string	Unique identifier of the policy or configuration object.
Name	string	Display name of the policy or configuration object.

Parameter	Type	Description
Policy	array	see below
policy.onprem	object	Container for on-premises policy settings.
policy.skypeonline.callinglineidentity	array	List of Calling Line Identity policies available in Skype Online.
policy.skypeonline.externalaccess	array	List of External Access policies controlling federation and public IM connectivity.
policy.skypeonline.onlinevoicemail	array	List of Online Voicemail policies, including transcription-related settings.
policy.skypeonline.onlinevoiceroutingpolicy	array	List of Online Voice Routing policies used for call routing.
policy.skypeonline.teamsapppermission	array	List of Teams App Permission policies that control app availability.
policy.skypeonline.teamsappsetup	array	List of Teams App Setup policies that define pinned and installed apps.
policy.skypeonline.teamsaudioconferencing	array	List of Teams Audio Conferencing policies.
policy.skypeonline.teamscalling	array	List of Teams Calling policies that define calling capabilities and restrictions.
policy.skypeonline.teamscallpark	array	List of Teams Call Park policies.
policy.skypeonline.teamschannels	array	List of Teams Channels policies controlling channel-related features.
policy.skypeonline.teamscompliancerecording	array	List of Teams Compliance Recording policies.
policy.skypeonline.teamsemergencycalling	array	List of Teams Emergency Calling policies.
policy.skypeonline.teamsemergencycallrouting	array	List of Teams Emergency Call Routing policies.
policy.skypeonline.teamsfeedback	array	List of Teams Feedback policies controlling feedback submission behavior.
policy.skypeonline.teamsipphone	array	List of Teams IP Phone policies.
policy.skypeonline.teamsmeeting	array	List of Teams Meeting policies controlling meeting capabilities and participant behavior.
policy.skypeonline.teamsmeetingbroadcast	array	List of Teams Meeting Broadcast (Live Events) policies.
policy.skypeonline.teamsmessaging	array	List of Teams Messaging policies controlling chat and messaging features.
policy.skypeonline.teamssurvivablebranchappliance	array	List of Teams Survivable Branch Appliance policies.
policy.skypeonline.teamsupgrade	array	List of Teams Upgrade policies defining coexistence and migration modes between Skype for Business and Teams.
policy.skypeonline.teamsvideointeropservice	array	List of Teams Video Interop Service (CVI) policies for third-party meeting room integration.
policy.skypeonline.tenantdialplan	array	List of Tenant Dial Plans used for number normalization and dialing behavior.
Configuration	array	See below
configuration.onprem	object	Container for on-premises configuration settings.
configuration.skypeonline.azureaddomain	array	List of Azure AD domain configurations associated with Skype Online.
configuration.skypeonline.networkroamingpolicy	array	List of Network Roaming policies controlling roaming-related behavior.
configuration.skypeonline.onlinepstnusage	array	List of Online PSTN Usage records used for voice routing and call authorization.
configuration.skypeonline.onlinevoiceroute	Array	List of Online Voice Routes that define call routing patterns and PSTN connectivity.

■

403 Forbidden

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id.
instance	string	Error instance.
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

404: No Found: for example, customers have been registered however have not yet been deployed.

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id.
instance	string	Error instance.
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

500 Internal Server Error

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id.
instance	string	Error instance.
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

503 Service Unavailable

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id.
instance	string	Error instance.
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk",
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"